Cards are a common organizing unit for modern user interfaces (UI). At their core, they’re just rectangular containers with borders and padding. However, when utilized properly to group related information, they help users better digest, engage, and navigate through content. This is why most successful dashboard/UI frameworks make cards a core feature of their component library. This article provides an overview of the API that bslib provides to create Bootstrap cards.
Setup code
To demonstrate that bslib cards work outside of Shiny (i.e., in R Markdown, static HTML, etc), we’ll make repeated use of statically rendered htmlwidgets like plotly and leaflet. Here’s some code to create those widgets:
library(bslib)
library(shiny)
library(htmltools)
library(plotly)
library(leaflet)
plotly_widget <- plot_ly(x = diamonds$cut) %>%
config(displayModeBar = FALSE) %>%
layout(margin = list(t = 0, b = 0, l = 0, r = 0))
leaflet_widget <- leafletOptions(attributionControl = FALSE) %>%
leaflet(options = .) %>%
addTiles()Shiny usage
Cards work equally well in Shiny. In the
examples below, replace plotly_widget with
plotlyOutput() and leaflet_widget with
leafletOutput() to adapt them for Shiny server-rendered
plots/maps.
Hello card()
A card() is designed to handle any number of “known”
card items (e.g., card_header(), card_body(),
etc) as unnamed arguments (i.e., children). As we’ll see shortly,
card() also has some useful named arguments (e.g.,
full_screen, height, etc).
At their core, card() and card items are just an HTML
div() with a special Bootstrap class, so you can use
Bootstrap’s utility classes to customize things like colors,
text, borders,
etc.
card(
card_header(
class = "bg-dark",
"A header"
),
card_body(
markdown("Some text with a [link](https://github.com)")
)
)Some text with a link
Implicit card_body()
If you find yourself using card_body() without changing
any of its defaults, consider dropping it altogether since any direct
children of card() that aren’t “known” card()
items, are wrapped together into an implicit card_body()
call.1
For example, the code to the right generates HTML that is identical to
the previous example:
card(
card_header(
class = "bg-dark",
"A header"
),
markdown("Some text with a [link](https://github.com).")
)Some text with a link.
Restricting growth
By default, a card()’s size grows to accommodate the
size of its contents. Thus, if a card_body() contains a
large amount of text, tables, etc., you may want to specify a
height or max_height. That said, when laying
out multiple cards, it’s likely best not
to specify height on the card(), and instead, let the
layout determine the height layout_column_wrap().
Although scrolling is convenient for reducing the amount of space
required to park lots of content, it can also be a nuisance to the user.
To help reduce the need for scrolling, consider pairing scrolling with
full_screen = TRUE (which adds an icon to expand the card’s
size to the browser window). Notice how, when the card is expanded to
full-screen, max_height/height won’t effect
the full-screen size of the card.
card(
max_height = 250,
full_screen = TRUE,
card_header(
"A long, scrolling, description"
),
lorem::ipsum(paragraphs = 3, sentences = 5)
)Sit cum penatibus pretium sociis mattis turpis ligula parturient. Nibh sociosqu consequat convallis eros nibh fusce mus turpis orci. Sed aliquet laoreet habitant sollicitudin habitasse mollis vehicula magna litora rutrum? Mi eu in curabitur, arcu donec platea – fusce malesuada dignissim! Nisl euismod duis laoreet viverra leo, lacinia imperdiet laoreet proin vel habitasse aenean odio elementum volutpat vitae fusce justo torquent quis!
Consectetur platea potenti aliquet aliquet interdum sed bibendum pharetra? Elementum aenean nam torquent: mus, auctor integer phasellus porttitor velit himenaeos venenatis. Sollicitudin sociosqu auctor tincidunt aptent lobortis quisque quis faucibus dictum purus maecenas? Eros suscipit tincidunt; proin, eros turpis semper vel turpis rhoncus? Magnis purus at cum donec, parturient dui integer, duis habitant turpis.
Elit magnis senectus taciti metus at venenatis: dui potenti ullamcorper. Praesent curae cubilia orci sem diam – dictum id laoreet, id curae lobortis cum. Sem cursus justo aenean placerat tempor – bibendum felis leo magnis. Conubia dictumst venenatis curabitur tristique egestas, aptent etiam sociosqu mollis nullam. Purus molestie platea integer.
Filling outputs
A card()’s default behavior is optimized for
facilitating filling layouts. More
specifically, if a fill item (e.g.,
plotly_widget), appears as a direct child of a
card_body(), it resizes to fit the card()s
specified height. This means, by specifying height = 250
we’ve effectively shrunk the plot’s height from its default of 400 down
to about 200 pixels. And, when expanded to full_screen, the
plot grows to match the card()’s new size.
card(
height = 250,
full_screen = TRUE,
card_header("A filling plot"),
card_body(plotly_widget)
)Most htmlwidgets (e.g., plotly, leaflet, etc) and some other Shiny
output bindings (e.g, plotOutput(),
imageOutput(), etc) are fill items by
default, so this behavior “just works” in those scenarios. And, in some
of these situations, it’s helpful to remove card_body()’s
padding, which can be done via spacing
& alignment utility classes.
card(
height = 275,
full_screen = TRUE,
card_header("A filling map"),
card_body(
class = "p-0",
leaflet_widget
),
card_footer(
class = "fs-6",
"Copyright 2023 RStudio, PBC"
)
)Fill item(s) aren’t limited in how much they grow
and shrink, which can be problematic when a card becomes very small. To
work around this, consider adding a min_height on the
card_body() container. For example, try using the handle on
the lower-right portion of this card example to make the card
taller/smaller.
This interactive example is a bit contrived in that we’re using CSS
resize to demonstrate how to make plots that don’t shrink beyond a
certain point, but this concept becomes quite useful when implementing
page-level filling layouts (i.e.,
page_fillable()) with multiple
cards.
card(
height = 300,
style = "resize:vertical;",
card_header("Plots that grow but don't shrink"),
card_body(
min_height = 250,
plotly_widget,
plotly_widget
)
)Troubleshooting fill
As you’ll learn more about in filling
layouts, a fill item loses its ability to fill when
wrapped in additional UI element that isn’t a fillable
container. To fix the situation, use as_fill_carrier() to
allow the additional element to carry the potential to fill from the
card_body() down to the fill item.
Multiple card_body()
A card() can have multiple card_body()s,
which is especially useful for:
- Combining both resizable and non-resizable contents (i.e., fill items and non-fill).
- Allowing each
card_body()to have their own styling (via inline styles and/or utility classes) and resizing limits (e.g.,min_height).
For example, when pairing filling output with scrolling content, you
may want min_height on the filling output since the
scrolling content will force it to shrink:
card(
height = 375,
full_screen = TRUE,
card_header(
"Filling plot, scrolling description"
),
card_body(
min_height = 200,
plotly_widget
),
card_body(
class = "lead container",
lorem::ipsum(paragraphs = 10, sentences = 5)
)
)Elit fusce, purus ut id fermentum facilisi. Condimentum mi diam mi eu etiam sodales – hendrerit enim orci! Facilisis lacinia sagittis lectus: ultrices tempor nisi varius. Venenatis convallis volutpat facilisi neque proin interdum sed. Semper facilisi eu vehicula vehicula dictumst turpis tortor nec class cras ac.
Consectetur duis mattis bibendum pretium velit, mollis augue. Malesuada netus aliquam himenaeos nisi facilisi inceptos; eu ante condimentum, accumsan molestie tincidunt! Sociosqu lacinia mattis erat habitasse est consequat imperdiet quis augue blandit. Tortor parturient nisi, aliquam et sociosqu sollicitudin facilisi dictumst urna semper. Rhoncus bibendum curabitur tincidunt.
Dolor neque sodales et fusce nisl, duis luctus eu. Sagittis semper, mattis eleifend mollis tempus viverra metus sociis parturient. Praesent nec morbi aenean, orci litora lacus dictum condimentum. Fusce luctus curabitur dapibus nisi eros, risus aliquet ac! Non nulla etiam mus justo, potenti senectus curae auctor.
Dolor himenaeos dapibus himenaeos taciti odio ridiculus, integer, quis ornare. Ultrices aptent faucibus aliquam metus nisi torquent mollis facilisi? Phasellus nulla velit quis leo suscipit tincidunt libero. Augue nunc placerat fusce duis nostra. Netus nascetur facilisi fusce ullamcorper et placerat inceptos ante pulvinar ante – dignissim parturient etiam sociis habitant.
Lorem himenaeos blandit eros placerat potenti etiam: libero quam blandit. Magnis magna pulvinar netus a mollis suspendisse luctus nascetur. Ac eros vehicula ornare, a euismod – suspendisse vel ridiculus lobortis! Sagittis ad orci integer, odio sociis elementum etiam potenti posuere ad. Phasellus consequat aliquet augue, augue porta – conubia senectus, magnis porttitor eleifend faucibus.
Lorem ridiculus urna, ante porttitor nulla volutpat mollis, libero semper natoque sagittis per congue. Habitasse curabitur, nisl vivamus parturient nec gravida elementum quis. Orci eget sollicitudin class porta per est proin lacinia. Nulla gravida facilisis ultrices varius aliquet id arcu ridiculus? Cum sem in diam bibendum cum conubia, dignissim porta ante sapien: fringilla, rhoncus litora fringilla?
Sit consequat massa facilisi euismod, morbi curae aliquet. Rutrum sapien mus hac per, conubia ultrices? Facilisis ut, lacinia torquent taciti molestie lacinia etiam. Lacinia tempor quisque purus auctor sociosqu commodo pretium. Maecenas lacus condimentum imperdiet malesuada eget mus, cursus tristique porttitor aptent mus, placerat semper congue penatibus placerat?
Ipsum risus ultrices massa lectus a proin velit ultricies; congue penatibus. Natoque aliquet lacinia vel proin molestie neque facilisis conubia. Magnis blandit duis molestie commodo condimentum a quisque magnis. Urna senectus vestibulum commodo pharetra ligula ante leo fames cum. Dui mauris maecenas turpis consequat cras orci placerat tempor.
Sit rhoncus nec, dui tincidunt ultrices nostra vehicula dapibus. Lobortis neque aenean nibh neque nisi sodales justo ultrices aliquam penatibus! Penatibus lectus litora eros ligula iaculis nunc sociis orci cubilia netus. Mauris fames volutpat vivamus suspendisse urna litora sociis malesuada. Vestibulum vestibulum magnis nulla lobortis dictumst ad, sociis facilisi duis aliquam cursus aliquet libero egestas habitant!
Elit praesent sagittis platea nullam parturient auctor vel sollicitudin! Ut ut et parturient condimentum quam urna curae laoreet porta. Lacinia faucibus augue platea porta. Ultricies a dis consequat eget – varius tempor himenaeos. Erat sagittis leo congue molestie sociosqu lacus suscipit varius et dis mauris, netus justo pharetra sollicitudin integer porttitor scelerisque nisi quisque ultricies.
Also, when the content has a fixed size, and should not be allowed to
scroll, set fill = FALSE:
card(
height = 350,
full_screen = TRUE,
card_header(
"Filling plot, short description"
),
plotly_widget,
card_body(
fill = FALSE, gap = 0,
card_title("A subtitle"),
p(class = "text-muted", "And a caption")
)
)A subtitle
And a caption
Multiple columns
As you’ll learn in column-based
layouts, layout_column_wrap() is great for multi-column
layouts that are responsive and accommodate for filling output. Here we have an equal-width
2-column layout using width = 1/2, but it’s also possible
to have varying column
widths.
card(
height = 350,
full_screen = TRUE,
card_header("A multi-column filling layout"),
card_body(
min_height = 200,
layout_column_wrap(
width = 1/2,
plotOutput("p1"),
plotOutput("p2")
)
),
lorem::ipsum(paragraphs = 3, sentences = 5)
)Ipsum at augue, maecenas, venenatis sociosqu tristique faucibus at cursus donec pretium malesuada! Est et vulputate rhoncus iaculis pharetra bibendum ligula malesuada, natoque auctor sociis? Tempus platea at nunc dignissim tortor a etiam. Hac ullamcorper dui mollis himenaeos, rutrum, per nam rhoncus, dis magna. Metus sociosqu risus taciti laoreet; venenatis risus ultricies semper ultrices luctus luctus felis.
Elit neque montes vulputate ad platea erat class natoque? Porta sed vestibulum lectus, metus suspendisse ornare pretium. Potenti scelerisque feugiat interdum auctor primis gravida sem. Congue dictum aliquam tincidunt dictum platea lobortis laoreet tempor nam odio montes! Ut vestibulum lacinia luctus in conubia – euismod auctor senectus, egestas vivamus neque.
Adipiscing at eros velit a convallis proin: rutrum egestas suspendisse! Faucibus habitasse torquent lacinia aliquam litora, accumsan facilisi est pharetra. Scelerisque id facilisi, elementum nam accumsan lacinia sed sociis? Curae condimentum urna faucibus non vulputate nibh, cum donec vel dignissim etiam? Sagittis praesent gravida vivamus tellus, lobortis eros malesuada mattis et.
Multiple cards
layout_column_wrap() is especially nice for laying out
multiple cards since each card in a particular row will have the same
height (by default). Learn more in column-based layouts.
layout_column_wrap(
width = 1/2,
height = 300,
card(full_screen = TRUE, card_header("A filling plot"), plotly_widget),
card(full_screen = TRUE, card_header("A filling map"), card_body(class = "p-0", leaflet_widget))
)Multiple tabs
navset_card_tab() and navset_card_pill()
make it possible to create cards with multiple tabs or pills. These
functions have the same full_screen capabilities as normal
card()s as well some other options like title
(since there is no natural place for a card_header() to be
used). Note that, each nav_panel() object is similar to a
card(). That is, if the direct children aren’t already card
items (e.g., card_title()), they get implicitly wrapped in a
card_body().
library(leaflet)
navset_card_tab(
height = 450,
full_screen = TRUE,
title = "HTML Widgets",
nav_panel(
"Plotly",
card_title("A plotly plot"),
plotly_widget
),
nav_panel(
"Leaflet",
card_title("A leaflet plot"),
leaflet_widget
),
nav_panel(
shiny::icon("circle-info"),
markdown("Learn more about [htmlwidgets](http://www.htmlwidgets.org/)")
)
)Sidebars
As you’ll learn more about in sidebar
layouts, layout_sidebar() just works when placed inside
in a card(). In this case, if you want fill
items (e.g., plotly_widget) to still fill the card
like we’ve seen before, you’ll need to
set fillable = TRUE in layout_sidebar().
card(
height = 300,
full_screen = TRUE,
card_header("A sidebar layout inside a card"),
layout_sidebar(
fillable = TRUE,
sidebar = sidebar(
actionButton("btn", "A button")
),
plotly_widget
)
)Static images
card_image() makes it easy to embed static (i.e.,
pre-generated) images into a card. Provide a URL to href to
make it clickable. In the case of multiple card_image()s,
consider laying them out in multiple cards
with layout_column_wrap() to produce a grid of clickable
thumbnails.
card(
height = 300,
full_screen = TRUE,
card_image(
file = "shiny-hex.svg",
href = "https://github.com/rstudio/shiny"
),
card_body(
fill = FALSE,
card_title("Shiny for R"),
p(
class = "fw-light text-muted",
"Brought to you by RStudio."
)
)
)
Shiny for R
Brought to you by RStudio.
Flexbox
Both card() and card_body() default to
fillable = TRUE (that is, they are CSS flexbox
containers), which works wonders for facilitating filling outputs, but it also leads to
surprising behavior with inline tags (e.g., actionButton(),
span(), strings, etc). Specifically, each inline tag is
placed on a new line, but in a “normal” layout flow
(fillable = FALSE), inline tags render inline.
card(
card_body(
fillable = TRUE,
"Here's some", tags$i("inline"), "text",
actionButton("btn1", "A button")
),
card_body(
fillable = FALSE,
"Here's some", tags$i("inline"), "text",
actionButton("btn2", "A button")
)
)That said, sometimes working in a flexbox layout is quite useful,
even when working with inline tags. Here we leverage flexbox’s gap
property to control the spacing between a plot, a (full-width) button,
and paragraph. Note that, by using markdown() for the
paragraph, it wraps the results in a <p> tag, which
means the contents of the paragraph are not longer subject to
flexbox layout. If we wanted, we could do something similar to render
the actionButton() inline by wrapping it in a
div().
card(
height = 325, full_screen = TRUE,
card_header("A plot with an action links"),
card_body(
class = "gap-2 container",
plotly_widget,
actionButton(
"go_btn", "Action button",
class = "btn-primary rounded-0"
),
markdown("Here's a _simple_ [hyperlink](https://www.google.com/).")
)
)In addition to gap, flexbox has really nice ways of handling otherwise difficult spacing and alignment issues. And, thanks to Bootstrap’s flex utility classes, we can easily opt-in and customize defaults.
card(
height = 300, full_screen = TRUE,
card_header(
class = "d-flex justify-content-between",
"Centered plot",
checkboxInput("check", " Check me", TRUE)
),
card_body(
class = "align-items-center",
plotOutput("id", width = "75%")
)
)Shiny
Since this article is statically rendered, the examples here use
statically rendered content/widgets, but the same card()
functionality works for dynamically rendered content via Shiny (e.g.,
plotOutput(), plotlyOutput(), etc).
An additional benefit that comes with using shiny is the ability to
use getCurrentOutputInfo() to render new/different content
when the output container becomes large enough, which is particularly
useful with card(full_screen = T, ...). For example, you
may want additional captions/labels when a plot is large, additional
controls on a table, etc (see the value
boxes article for a clever use of this).
# UI logic
ui <- page_fluid(
card(
max_height = 200,
full_screen = TRUE,
card_header("A dynamically rendered plot"),
plotOutput("plot_id")
)
)
# Server logic
server <- function(input, output, session) {
output$plot_id <- renderPlot({
info <- getCurrentOutputInfo()
if (info$height() > 600) {
# code for "large" plot
} else {
# code for "small" plot
}
})
}
shinyApp(ui, server)Appendix
The following CSS is used to give plotOutput() a
background color; it’s necessary here because this documentation page is
not actually hooked up to a Shiny app, so we can’t show a real plot.